-
Notifications
You must be signed in to change notification settings - Fork 3
Update current release #120
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: latest
Are you sure you want to change the base?
Conversation
* Remove docker from user facing docks * Remove container and docker mentions * Remove SP3 * Add env for wanda * Use vars and upcast rpm * Add explicit sle 16.0
* Fix TRNT-3895 * Add feedback
* Add local docs build * Fix selinux permission * Add workflow guide
* Restructure trento install section * Remove partial as it was included in kubernetes partial * Aligned naming of partial and added revdate to kubernetes
| @@ -0,0 +1,36 @@ | |||
| == Local Documentation Preview with Docker | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This part is just developer docs for new way of preview antora with docker
| :revdate: 2025-10-16 | ||
|
|
||
|
|
||
| [[sec-trento-k8s-deployment]] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moved to trento-kubernetes-install.adoc[]
| + | ||
| . Restart the application. | ||
|
|
||
| ==== Enabling OpenID Connect when using Docker images |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Part of docker mention removal
| + | ||
| . Restart the application. | ||
|
|
||
| [[enabling-oauth-20-when-using-docker-images]] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Part of docker mention removal
| + | ||
| . Restart the application. | ||
|
|
||
| ==== Enabling SAML when using Docker images |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Part of docker mention removal
| [[sec-trento-install-trentoserver-on-existing-k8s-cluster]] | ||
| ==== Installing {trserver} on an existing {k8s} cluster | ||
|
|
||
| {trserver} consists of a several components delivered as container images and intended for deployment on a {k8s} cluster. A manual production-ready deployment of these components requires {k8s} knowledge. Customers without in-house {k8s} expertise and who want to try {trento} with a minimum of effort, can use the {trento} Helm chart. This approach automates the deployment of all the required components on a single {k8s} cluster node. You can use the {trento} Helm chart to install {trserver} on a existing {k8s} cluster as follows: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| {trserver} consists of a several components delivered as container images and intended for deployment on a {k8s} cluster. A manual production-ready deployment of these components requires {k8s} knowledge. Customers without in-house {k8s} expertise and who want to try {trento} with a minimum of effort, can use the {trento} Helm chart. This approach automates the deployment of all the required components on a single {k8s} cluster node. You can use the {trento} Helm chart to install {trserver} on a existing {k8s} cluster as follows: | |
| {trserver} consists of a several components delivered as container images and intended for deployment on a {k8s} cluster. A manual production-ready deployment of these components requires {k8s} knowledge. Customers without in-house {k8s} expertise and those who want to try {trento} with a minimum of effort, can use the {trento} Helm chart. This approach automates the deployment of all the required components on a single {k8s} cluster node. You can use the {trento} Helm chart to install {trserver} on a existing {k8s} cluster as follows: |
| [[sec-trento-install-trentoserver-on-k3s]] | ||
| ==== Installing {trserver} on K3s | ||
|
|
||
| If you do not have a {k8s} cluster, or have one but do not want to use it for {trento}, {suse} Rancher's K3s provides an alternative. To deploy {trserver} on K3s, you need a small server or VM (see <<sec-trento-server-requirements>> for minimum requirements) and follow steps in <<pro-trento-manually-installing>>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| If you do not have a {k8s} cluster, or have one but do not want to use it for {trento}, {suse} Rancher's K3s provides an alternative. To deploy {trserver} on K3s, you need a small server or VM (see <<sec-trento-server-requirements>> for minimum requirements) and follow steps in <<pro-trento-manually-installing>>. | |
| If you do not have a {k8s} cluster, or you have one but you do not want to use it for {trento}, you can use {suse} Rancher's K3s as an alternative. To deploy {trserver} on K3s, you need a server or VM (see <<sec-trento-server-requirements>> for minimum requirements) and follow steps in <<pro-trento-manually-installing>>. |
| Sender email for alert notifications | ||
|
|
||
| `ALERTING_RECIPIENT`:: | ||
| Recipient email for alert notifications. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Recipient email for alert notifications. | |
| Email address to receive alert notifications. |
abravosuse
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job overall @EMaksy. Just some minor changes.
If you see a suggestion that changes nothing, it's because I first made a suggestion only valid for the new version. And when I realized it, I undid my changes. Sorry.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do not understand this. It says the file has been deleted, but I can still see its content in the html generated by antora.
For the record, this information should not be removed from the user facing documentation. It's relevant.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From this section, we should remove the reference to Docker images.
| // Variable List for tragent | ||
| {tragent}:: | ||
| + | ||
| Delivery mechanism::: RPM package for {sles4sap} 15 SP3 and newer. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Delivery mechanism::: RPM package for {sles4sap} 15 SP3 and newer. | |
| Delivery mechanism::: RPM package for {sles4sap} 15 SP3 and newer. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Line 25: Replace "{suse} recommends {suse} {rke} (RKE) version 1 or 2" with "{suse} recommends {{rke} version". 2."
| In case of a containerized deployment, provide the logs of the | ||
| trento-web and trento-wanda containers. Use `+docker ps+` to retrieve |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| In case of a containerized deployment, provide the logs of the | |
| trento-web and trento-wanda containers. Use `+docker ps+` to retrieve |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Delete, also, lines 25 and 26. I could not include them in my suggestion.
| {trserver} supports different deployment scenarios: {k8s}, systemd, and containers. A {k8s}-based deployment of {trserver} is cloud-native and OS-agnostic. It can be performed on the following services: | ||
| {trserver} supports different deployment scenarios: {k8s} and systemd. A {k8s}-based deployment of {trserver} is cloud-native and OS-agnostic. It can be performed on the following services: | ||
|
|
||
| * RKE1 ({rancher_k8s_engine} version 1) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * RKE1 ({rancher_k8s_engine} version 1) |
| * *{trserver}* For a {k8s}-based deployment, you must have access to {suse} public registry for the deployment of {trserver} containers. For a systemd deployment, you must have a registered {sles4sap} 15 (SP3 or higher) distribution. The same applies to a containerized deployment. | ||
| * *{tragent}s* A registered {sles4sap} 15 (SP3 or higher) distribution. | ||
| * *{trserver}* For a {k8s}-based deployment, you must have access to {suse} public registry for the deployment of {trserver} containers. For a systemd deployment, you must have a registered {sles4sap} 15 (SP4 or higher) or {sles4sap} 16.0 distribution. | ||
| * *{tragent}s* A registered {sles4sap} 15 (SP3 or higher) distribution. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * *{tragent}s* A registered {sles4sap} 15 (SP3 or higher) distribution. | |
| * *{tragent}s* A registered {sles4sap} 15 (SP3 or higher) distribution. |
trento/adoc/trento-requirements.adoc
Outdated
|
|
||
| * *{trserver}* For a {k8s}-based deployment, you must have access to {suse} public registry for the deployment of {trserver} containers. For a systemd deployment, you must have a registered {sles4sap} 15 (SP3 or higher) distribution. The same applies to a containerized deployment. | ||
| * *{tragent}s* A registered {sles4sap} 15 (SP3 or higher) distribution. | ||
| * *{trserver}* For a {k8s}-based deployment, you must have access to {suse} public registry for the deployment of {trserver} containers. For a systemd deployment, you must have a registered {sles4sap} 15 (SP4 or higher) or {sles4sap} 16.0 distribution. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * *{trserver}* For a {k8s}-based deployment, you must have access to {suse} public registry for the deployment of {trserver} containers. For a systemd deployment, you must have a registered {sles4sap} 15 (SP4 or higher) or {sles4sap} 16.0 distribution. | |
| * *{trserver}* For a {k8s}-based deployment, you must have access to {suse} public registry for the deployment of {trserver} containers. For a systemd deployment, you must have a registered {sles4sap} 15 (SP3 or higher) distribution. |
Description
This pr updates the released documentation in the latest branch. I was following our our critical hotfix workflow https://www.trento-project.io/docs/developer/trento-docs-site/collaboration-docs-team/docs-git-workflow.html#_3_applying_a_critical_hotfix.

With this we have also a nice history in the commits :)
When we release Trento 3.0 we will follow this workflow
https://www.trento-project.io/docs/developer/trento-docs-site/collaboration-docs-team/docs-git-workflow.html#_2_publishing_a_new_release
Features